Skip to main content

Products

The Products API provides organizations visibility over all products linked to their accounts and subscriptions. It allows organizations to ensure their accounts and subscriptions include the required plans or add-ons, verify that highly regulated subscribers or teams have the correct recording services applied, and identify products nearing termination.

How it works​

List All Products​

Send an HTTP GET request to 1GLOBAL to retrieve a list of all products associated with the organization’s accounts.

GET https://api.1global.com/enterprise/products/items

The header must contain the URL, Request Access Token, and content-type as shown below.

curl -X GET \
  https://api.1global.com/enterprise/products
   -H 'Authorization: Bearer $ACCESS_TOKEN' \
   -H 'Content-Type: application/json' \

Example Response:

{
  "_links": {
    "self": {
      "href": "https://api.staging.1global.com/enterprise/products?status=active&limit=10"
    },
    "next": {
      "href": "https://api.staging.1global.com/enterprise/products?status=active&cursor=ND4653654FGFygfg&limit=10"
    }
  },
  "_embedded": {
    "products": [
      {
        "id": "prod_01ABCDEF1234567890",
        "status": "active",
        "activated_at": "2024-08-12T17:42:35Z",
        "_links": {
          "self": {
            "href": "https://api.staging.1global.com/enterprise/products/prod_01ABCDEF1234567890"
          },
          "account": {
            "href": "https://api.staging.1global.com/enterprise/accounts/acc_01ACCOUNT123456"
          },
          "subscription": {
            "href": "https://api.staging.1global.com/enterprise/subscriptions/sub_01SUBSCRIPTION123456"
          }
        },
        "_embedded": {
          "product_offering": {
            "id": "prdoff_01CATALOG123456",
            "name": "Europe 1GB Plan Monthly fee",
            "type": "plan"
          }
        }
      }
    ]
  }
}

Continue navigating through the next links in the response until you have retrieved all the products list. Refer Standards - Pagination for more information on pagination.

NOTE: The 'product_offering' corresponds to the catalog item, while the 'id' of the product represents the actual product instance associated with a specific account or subscription.

Retrieve a Product​

Retrieve a single product and its details by specifying the product ID.

GET  https://api.1global.com/enterprise/products/{pdr_id}

The header should contain the endpoint URL along with the product Id, Request Access Token, and content-type as shown below:

curl -X GET \
  https://api.1global.com/enterprise/products/prd_012GHGHFHF2455HHHGHGHG111X \
   -H 'Authorization: Bearer $ACCESS_TOKEN' \
   -H 'Content-Type: application/json'

Example Response: A successful request returns an HTTP status 200 and a response body containing information about the specified suscriber.

{
        "id": "prod_01ABCDEF1234567890",
        "status": "active",
        "activated_at": "2024-08-12T17:42:35Z",
        "_links": {
          "self": {
            "href": "https://api.staging.1global.com/enterprise/products/prod_01ABCDEF1234567890"
          },
          "account": {
            "href": "https://api.staging.1global.com/enterprise/accounts/acc_01ACCOUNT123456"
          },
          "subscription": {
            "href": "https://api.staging.1global.com/enterprise/subscriptions/sub_01SUBSCRIPTION123456"
          }
        },
        "_embedded": {
          "product_offering": {
            "id": "prdoff_01CATALOG123456",
            "name": "Europe 1GB Plan Monthly fee",
            "type": "plan"
        }
    }
 }